/*
 *  Copyright (C) 2011 glauco
 * 
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 * 
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.common;

/**
 *
 * @author glauco
 */
public interface Message {

    /**
     * Level da Mensagem
     */
    public static final int CONFIRMATION = 0;

    /**
     * Level da Mensagem
     */
    public static final int INFORMATION = 1;

    /**
     * Level da Mensagem
     */
    public static final int WARNING = 2;

    /**
     * Level da Mensagem
     */
    public static final int ERROR = 3;

    /**
     * Retorna o identificador da mensagem.
     */
    public Object getId();

    /**
     * Texto da mensagem a ser exibida ao usuário.
     */
    public String getMessage();

    /**
     * Level da mensagem (Severidade).
     * Os valores válidos são:
     *  - Zero (0) para mensagens de confirmação;
     *  - Um (1) para mensagens de informação;
     *  - Dois (2) para mensagens de alerta;
     *  - Três (3) para mensagens de erro.
     * @see #CONFIRMATION
     * @see #INFORMATION
     * @see #WARNING
     * @see #ERROR
     */
    public int getLevel();
}
